home *** CD-ROM | disk | FTP | other *** search
/ Aminet 28 / Aminet 28 (1998)(GTI - Schatztruhe)[!][Dec 1998].iso / Aminet / util / libs / board219.lha / boardslib / developer / autodoc / boards.doc
Encoding:
Text File  |  1998-10-08  |  4.3 KB  |  175 lines
  1. TABLE OF CONTENTS
  2.  
  3. boards.library/AllocBoardInfo
  4. boards.library/FreeBoardInfo
  5. boards.library/GetBoardName
  6. boards.library/NextBoardInfo
  7.  
  8.  
  9. boards.library/AllocBoardInfo                   boards.library/AllocBoardInfo
  10.  
  11.    NAME
  12.     AllocBoardInfo - allocate a BoardInfo structure , that can be
  13.              filled with NextBoardInfo (V2)
  14.  
  15.    SYNOPSIS
  16.     BoardInfo = AllocBoardInfo (BoardInfoFlags)
  17.       D0                D0
  18.  
  19.     APTR AllocBoardInfo(ULONG);
  20.  
  21.    FUNCTION
  22.     allocate a BoardInfo structure
  23.  
  24.    INPUTS
  25.     BoardInfoFlags - with this flags you can manipulate the Stringformat
  26.              ( 0 = Default settings )
  27.  
  28.         These Flags are known in V 2.0 :
  29.  
  30.         SB_EXPANSION_SIZE_HEX    ;Expansion size HEX (ASCII)
  31.         SB_MANUFACTURERID_HEX    ;ManufacturerID HEX (ASCII)
  32.         SB_PRODUCTID_HEX    ;ProductID HEX (ASCII)
  33.         SB_SERIALNUMBER_HEX    ;SerialNumber HEX (ASCII)
  34.         SB_CONFIGDEV_FLAGS_DEC    ;ConfigDev flags DEC (ASCII)
  35.         SB_EXPANSION_TYPE_DEC    ;Expansion type DEC (ASCII)
  36.  
  37.  
  38.    RESULT
  39.     BoardInfo      - Pointer to BoardInfo structure or NULL.
  40.  
  41.    NOTE
  42.     You must use this function, before you call NextBoardInfo().
  43.     If BoardInfo structure not used anymore, you must call
  44.     FreeBoardInfo().
  45.     This call is guaranteed to preserve all registers except D0.
  46.  
  47.    BUGS
  48.  
  49.    SEE ALSO
  50.     NextBoardInfo, FreeBoardInfo
  51.  
  52.  
  53. boards.library/FreeBoardInfo                     boards.library/FreeBoardInfo
  54.  
  55.    NAME
  56.     FreeBoardInfo - deallocate BoardInfo structure (V2)
  57.  
  58.    SYNOPSIS
  59.     FreeBoardInfo (BoardInfo)
  60.               A0
  61.  
  62.     VOID FreeBoardInfo(struct BoardInfo*);
  63.  
  64.    FUNCTION
  65.     deallocate BoardInfo structure
  66.  
  67.    INPUTS
  68.     BoardInfo     - Pointer to BoardInfo structure
  69.  
  70.    RESULT
  71.  
  72.    NOTE
  73.     This call is guaranteed to preserve all registers.
  74.  
  75.    BUGS
  76.  
  77.    SEE ALSO
  78.     AllocBoardInfo, NextBoardInfo
  79.  
  80.  
  81. boards.library/GetBoardName                       boards.library/GetBoardName
  82.  
  83.    NAME
  84.     GetBoardName - get the name of manufacturer and product
  85.                        of the given expansion board
  86.  
  87.    SYNOPSIS
  88.     Success = GetBoardName(ManName,ProdName,ConfigDev,ManuID,ProdID)
  89.       D0                     A0       A1       A2       D0     D1
  90.  
  91.     BOOL GetBoardName(UBYTE *,UBYTE *,struct ConfigDev*,UWORD,UBYTE);
  92.  
  93.    FUNCTION
  94.     Gets the name of the manufacturer and product of the given
  95.         expansion board.
  96.  
  97.    INPUTS
  98.     ManName       - Stringbuffer to be filled with the manufacturer name.
  99.             Must be at least 48 chars long.
  100.  
  101.     ProdName      - Stringbuffer to be filled with the product name.
  102.             Must be at least 48 chars long.
  103.  
  104.     ConfigDev     - Pointer to ConfigDev structure (from expansion.library)
  105.             or NULL.
  106.             If a ConfigDev structure given, Manufacturer and Product
  107.             was ignored ( ConfigDev have a higher priority )
  108.             
  109.  
  110.     ManuID          - ID of the board's manufacturer.
  111.  
  112.     ProdID        - ID of the board's product number.
  113.  
  114.             If you use Manufacturer and Product, the ConfigDev must
  115.             be NULL.
  116.  
  117.  
  118.    RESULT
  119.     Success       - True if both manufacturer and product are known. False
  120.             if one of them are not known.
  121.  
  122.    NOTE
  123.     If the manufacturer or the product is not known, the string will be
  124.     filled with a "unknown" and its number. It`s NOT a real fault if this
  125.     function fails, only the library not known the board by the name.
  126.  
  127.     This call is guaranteed to preserve all registers except D0.
  128.  
  129.    BUGS
  130.     There are by far not all existing boards implemented. Please send
  131.     me the manufacturer id and name and the products id and name of all
  132.     unknown boards. E-Mail: "lsi@berlin.snafu.de".
  133.  
  134.    SEE ALSO
  135.  
  136.     The "boards.library" use the same method like "expname.library".
  137.     You can simple replace them.
  138.  
  139.  
  140. boards.library/NextBoardInfo                     boards.library/NextBoardInfo
  141.  
  142.    NAME
  143.     NextBoardInfo - filled BoardInfo structure and the StringPointers
  144.             with Data (V2)
  145.  
  146.    SYNOPSIS
  147.     ConfigDev = NextBoardInfo (BoardInfo,ConfigDev)
  148.       D0                 A0        A1
  149.  
  150.     APTR NextBoardInfo(struct BoardInfo*,struct ConfigDev*);
  151.  
  152.    FUNCTION
  153.     filled BoardInfo structure and the StringPointers with Data 
  154.  
  155.    INPUTS
  156.     BoardInfo     - Pointer to BoardInfo structure
  157.  
  158.     ConfigDev     - Pointer to ConfigDev structure or NULL.
  159.             (if ConfigDev=NULL -> search for first board )
  160.             if ConfigDev not NULL -> search for the next
  161.             board after that ConfigDev          
  162.  
  163.    RESULT
  164.     ConfigDev     - Pointer to ConfigDev structure or NULL.
  165.  
  166.    NOTE
  167.     You must allocate the BoardInfo structure with AllocBoardInfo().
  168.     This call is guaranteed to preserve all registers except D0.
  169.  
  170.    BUGS
  171.  
  172.    SEE ALSO
  173.     AllocBoardInfo, FreeBoardInfo
  174.  
  175.